id is the Fire spark payment UUID.
Requires an access token with the
payments:read scope. See
Token to obtain a token.Path parameters
| Parameter | Required | Description |
|---|---|---|
id | Yes | Fire spark payment UUID. |
Request
curl "https://firespark.cloud/api/integrations/v1/payments/3b1c8f2e-5a44-4d1b-9c0e-2f6a1d8b7e90" \
-H "Authorization: Bearer ACCESS_TOKEN"
Response
The response wraps one payment object indata. Secrets are stripped from config.
{
"data": {
"id": "3b1c8f2e-5a44-4d1b-9c0e-2f6a1d8b7e90",
"payment_provider_id": "6f1c8f2e-5a44-4d1b-9c0e-2f6a1d8b7e90",
"payment_method_id": "7c1c8f2e-5a44-4d1b-9c0e-2f6a1d8b7e90",
"config": { "public_key": "pk_test_123" },
"rules": [{ "minimum_order_value": 5, "maximum_order_value": 200 }],
"conditions": [
[
{
"primitive": "currency",
"type": "Order total",
"operator": "greater than or equal to",
"value": 10
}
]
],
"store_ids": null,
"channel_ids": ["app"],
"brand_ids": null,
"fulfillment_ids": null,
"store_label_ids": null,
"channel_label_ids": null,
"brand_label_ids": null,
"fulfillment_label_ids": null,
"status": "ACTIVE",
"provider": {
"id": "6f1c8f2e-5a44-4d1b-9c0e-2f6a1d8b7e90",
"provider_id": "kushki",
"name": "Kushki",
"logo_url": null
},
"method": {
"id": "7c1c8f2e-5a44-4d1b-9c0e-2f6a1d8b7e90",
"method": "CARD",
"name": "Card",
"version": "1.0.0"
}
}
}
Payment object
| Field | Type | Description |
|---|---|---|
id | string (UUID) | Fire spark payment identifier. |
payment_provider_id | string (UUID) | Catalog provider row. |
payment_method_id | string (UUID) | Catalog method row. Must belong to that provider. |
config | object | Provider credentials without private_key and webhook_signature. For firespark REDEMPTION, the optional logo_url of the redemption source. |
rules | array | Order-total windows. See Upsert payments. |
conditions | array | OR of AND groups. See Upsert payments. |
store_ids, channel_ids, brand_ids, fulfillment_ids | array or null | External ids. null means every id of that kind. |
store_label_ids, channel_label_ids, brand_label_ids, fulfillment_label_ids | array or null | Label UUIDs. null means every label. |
status | string | ACTIVE or INACTIVE. |
provider | object | id, provider_id slug, name, logo_url. |
method | object | id, method (CASH, CARD, BANK_TRANSFER, WALLET, PIN_PAD), name, version. |
Error responses
| Status | Description |
|---|---|
401 | Missing or invalid access token |
403 | Token does not include payments:read |
404 | No payment exists for this id |